bargraph2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

// ----------------------------------------------------------------------------
 
#ifndef BARGRAPH2_H
#define BARGRAPH2_H

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 

 
#define BARGRAPH2_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.miso  = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi  = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck   = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs    = MIKROBUS( mikrobus, MIKROBUS_CS ); \
   cfg.mr    = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.pwm   = MIKROBUS( mikrobus, MIKROBUS_PWM )


#define BARGRAPH2_RETVAL  uint8_t
 
#define BARGRAPH2_OK           0x00
#define BARGRAPH2_INIT_ERROR   0xFF

#define BARGRAPH2_POWER_ON    1
#define BARGRAPH2_POWER_OFF   0

#define BARGRAPH2_LED_SEG_0   0x00
#define BARGRAPH2_LED_SEG_1   0x01
#define BARGRAPH2_LED_SEG_2   0x02
#define BARGRAPH2_LED_SEG_3   0x04
#define BARGRAPH2_LED_SEG_4   0x08
#define BARGRAPH2_LED_SEG_5   0x10
#define BARGRAPH2_LED_SEG_6   0x20
#define BARGRAPH2_LED_SEG_7   0x40
#define BARGRAPH2_LED_SEG_8   0x80
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES

typedef struct
{
    digital_out_t cs;
 
    // Output pins 
 
    digital_out_t mr;
    digital_out_t pwm;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} bargraph2_t;

typedef struct
{
    // Communication gpio pins 
 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins 
 
    pin_name_t mr;
    pin_name_t pwm;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t  spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} bargraph2_cfg_t;
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS

#ifdef __cplusplus
extern "C"{
#endif

void bargraph2_cfg_setup ( bargraph2_cfg_t *cfg );

BARGRAPH2_RETVAL bargraph2_init ( bargraph2_t *ctx, bargraph2_cfg_t *cfg );

void bargraph2_default_cfg ( bargraph2_t *ctx );

void bargraph2_generic_transfer ( bargraph2_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );

void bargraph2_reset ( bargraph2_t *ctx ); 

void bargraph2_write_byte ( bargraph2_t *ctx, uint8_t input_data ); 

void bargraph2_led_green ( bargraph2_t *ctx, uint8_t index );

void bargraph2_led_red ( bargraph2_t *ctx, uint8_t index );

void bargraph2_led_yellow ( bargraph2_t *ctx, uint8_t index );

void bargraph2_leds_green ( bargraph2_t *ctx, int start_index, int end_index ); 

void bargraph2_leds_red ( bargraph2_t *ctx, int start_index, int end_index ); 

void bargraph2_leds_yellow ( bargraph2_t *ctx, int start_index, int end_index );

void bargraph2_lights_out ( bargraph2_t *ctx ); 

void barpgraph2_power ( bargraph2_t *ctx, uint8_t power_on_off );
 
#ifdef __cplusplus
}
#endif
#endif  // _BARGRAPH2_H_
 // End public_function group

// ------------------------------------------------------------------------- END